Remove unreleased dependency tags when library is shipped #45427
+86
−52
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alzimmermsft
requested review from
samvaity,
g2vinay,
joshfree,
srnagar,
anuchandy,
conniey,
lmolkova and
JonathanGiles
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR removes outdated unreleased_ dependency tags once a library ships and enforces consistency checks for unreleased versions.
- Updated Maven POMs to drop
unreleased_markers in version-update comments. - Removed stale entries from the version client file.
- Enhanced
utils.pywith stricter validation and automatic removal of matching unreleased tags on version increment. - Adjusted
update_versions.pyfor proper path handling and replacement of unreleased dependency markers.
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/keyvault-v2/azure-security-keyvault-secrets/pom.xml | dropped unreleased_ prefix in x-version-update comment |
| sdk/keyvault-v2/azure-security-keyvault-keys/pom.xml | dropped unreleased_ prefix in x-version-update comment |
| sdk/keyvault-v2/azure-security-keyvault-certificates/pom.xml | dropped unreleased_ prefix in x-version-update comment |
| sdk/keyvault-v2/azure-security-keyvault-administration/pom.xml | dropped unreleased_ prefix in x-version-update comment |
| sdk/identity-v2/azure-identity/pom.xml | dropped unreleased_ prefix in x-version-update comment |
| eng/versioning/version_client.txt | removed two unreleased_ entries for shipped libraries |
| eng/versioning/utils.py | added unreleased version checks and removal logic |
| eng/versioning/update_versions.py | improved file path resolution and dependency replacement |
Comments suppressed due to low confidence (3)
eng/versioning/utils.py:193
- [nitpick] Variable
tempNameuses camelCase; rename totemp_nameto follow Python's snake_case naming convention.
tempName = module.name
eng/versioning/update_versions.py:60
- The code uses
os.pathfunctions butosis not imported. Addimport osat the top of this file to avoid NameError.
print('processing: ' + os.path.normpath(target_file))
eng/versioning/utils.py:112
- [nitpick] Use
is not Noneinstead of!= Nonefor clearer intent and Pythonic style (e.g.,if self.external_dependency is not None:).
if self.external_dependency != None:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes #42114
Changes to
update_versions.pyandutils.pyto better handleunreleased_dependencies. The following changes were made:unreleased_dependency exists. Having the same version should only happen when a library has not shipped at least once yet.unreleased_version matches the dependency version of the library all references of the unreleased version will be removed.All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines